home *** CD-ROM | disk | FTP | other *** search
/ Directorty Opus 5 - Magellan 2 / Opus 5 - Magellan 2.iso / Extras / opussdk / docs / diskio.doc < prev    next >
Text File  |  1996-09-05  |  2KB  |  82 lines
  1. TABLE OF CONTENTS
  2.  
  3. dopus5.library/OpenDisk
  4. dopus5.library/CloseDisk
  5. dopus5.library/OpenDisk                               dopus5.library/OpenDisk
  6.  
  7.     NAME
  8.         OpenDisk - open a disk for direct I/O
  9.  
  10.     SYNOPSIS
  11.         OpenDisk(disk, port)
  12.                   A0    A1
  13.  
  14.         DiskHandle *OpenDisk(char *, struct MsgPort *);
  15.  
  16.     FUNCTION
  17.         This routine makes it easy to access the underlying device for
  18.         direct I/O. It allows you to open any filesystem (that supports
  19.         direct I/O) with just the device name.
  20.  
  21.     INPUTS
  22.         disk - name of disk to open, eg DF0:, HD1:
  23.         port - message port to use, or NULL
  24.  
  25.     RESULT
  26.         If this function succeeds, it returns a DiskHandle structure,
  27.         which contains all the information you need to access the device
  28.         directly. The structure fields are :
  29.  
  30.             dh_Port
  31.                 If you did not supply a message port to use, one is
  32.                 created automatically and its address is stored here. Usually
  33.                 you will want a port created for you, but if you are working
  34.                 with multiple devices at once you might want them all to share
  35.                 the same message port.
  36.  
  37.             dh_IO
  38.                 This is a pointer to an IOExtTD structure, which you can use
  39.                 to perform I/O on the device.
  40.  
  41.             dh_Startup
  42.                 A pointer to the FileSysStartupMsg of the device.
  43.  
  44.             dh_Geo
  45.                 A pointer to the DosEnvec structure of the device.
  46.  
  47.             dh_Device
  48.                 Full device name (without a colon)
  49.  
  50.             dh_Info/dh_Result
  51.                 If dh_Result is TRUE, dh_Info is valid, and contains current
  52.                 information about the disk.
  53.  
  54.             dh_Root/dh_BlockSize
  55.                 These give the block number of the disk's root block, and
  56.                 the block size.
  57.  
  58.     SEE ALSO
  59.         CloseDisk(), trackdisk.doc
  60.  
  61. dopus5.library/CloseDisk                             dopus5.library/CloseDisk
  62.  
  63.     NAME
  64.         CloseDisk - close a DiskHandle structure
  65.  
  66.     SYNOPSIS
  67.         CloseDisk(handle)
  68.                     A0
  69.  
  70.         void CloseDisk(DiskHandle *);
  71.  
  72.     FUNCTION
  73.         This function cleans up and closes a DiskHandle structure opened
  74.         with the OpenDisk() routine.
  75.  
  76.     INPUTS
  77.         handle - DiskHandle to close
  78.  
  79.     SEE ALSO
  80.         OpenDisk()
  81.  
  82.